// Copyright 2007-2009, Stanford University. All Rights Reserved.
// Copyright 2010-2011, Dependable Systems Lab, EPFL. All Rights Reserved.
// Copyright 2012, Google Inc. All Rights Reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimers.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimers
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the names of the klee Team, Stanford University, nor the
// names of its contributors may be used to endorse or promote
// products derived from the software without specific prior
// written permission. Neither the names of the Dependable Systems
// Laboratory, EPFL, nor the names of its contributors may be used to
// endorse or promote products derived from the software without prior
// written permission. Neither the names of Google Inc. nor the names of
// its contributors may be used to endorse or promote products derived from
// the software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef SRC_SOLVER_CONSTANTDIVISION_H_
#define SRC_SOLVER_CONSTANTDIVISION_H_

#include <stdint.h>

namespace seven_summits {
namespace solver {

/// ComputeMultConstants64 - Compute add and sub such that add-sub==x,
/// while attempting to minimize the number of bits in add and sub
/// combined.
void ComputeMultConstants64(uint64_t x, uint64_t &add_out,
                            uint64_t &sub_out);

/// Compute the constants to perform a quicker equivalent of a division of some
/// 32-bit unsigned integer n by a known constant d (also a 32-bit unsigned
/// integer).  The constants to compute n/d without explicit division will be
/// stored in mprime, sh1, and sh2 (unsigned 32-bit integers).
///
/// @param d - denominator (divisor)
///
/// @param [out] mprime
/// @param [out] sh1
/// @param [out] sh2
void ComputeUDivConstants32(uint32_t d, uint32_t &mprime, uint32_t &sh1,
                            uint32_t &sh2);

/// Compute the constants to perform a quicker equivalent of a division of some
/// 32-bit signed integer n by a known constant d (also a 32-bit signed
/// integer).  The constants to compute n/d without explicit division will be
/// stored in mprime, dsign, and shpost (signed 32-bit integers).
///
/// @param d - denominator (divisor)
///
/// @param [out] mprime
/// @param [out] dsign
/// @param [out] shpost
void ComputeSDivConstants32(int32_t d, int32_t &mprime, int32_t &dsign,
                            int32_t &shpost);

}  // solver
}  // seven_summits

#endif  // SRC_SOLVER_CONSTANTDIVISION_H_
